tui-markdown 0.1.1

A simple library for converting markdown to a Rataui Text value
Documentation

Tui-markdown

A library for converting markdown content to a Ratatui Text value. See Markdown-reader for an example application that uses this library.

Crate badge Docs.rs Badge Deps.rs Badge License Badge Codecov.io Badge Discord Badge

GitHub Repository · API Docs · [Examples] · Changelog · Contributing

Installation

cargo add tui-markdown

Usage

let input = "# Heading\n\n**bold**"; // this can come from whereever
let text = tui_markdown::from_str(input);
text.render(area, &mut buf);

Status

Initial implementation - this is very much WIP (see lib.rs todo!()s)

  • Headings
  • Heading attributes / classes / anchors
  • Normal paragraphs
  • Block quotes
  • Nested block quotes
  • Bold (strong)
  • Italic (emphasis)
  • Strikethrough
  • Ordered lists
  • Unordered lists
  • Code blocks
  • Html
  • Footnotes
  • Tables
  • Linebreak handling
  • Rule
  • Tasklists
  • Links
  • Images
  • Metadata blocks